Add schema descriptions for runs-on and concurrency fields by Copilot · Pull Request #2819 · github/gh-aw

Copilot · 2025-10-30T20:02:26Z

Add schema descriptions for runs-on and concurrency fields ✅

Summary

Successfully added minimal, neutral descriptions to the runs-on and concurrency top-level fields in the workflow schema, following @pelikhan's guidance "This is by design. Add documentation to not report this anymore."

Changes Made

Understand the issue and schema structure
Add minimal top-level description to runs-on field
Add minimal top-level description to concurrency field
Build and test to ensure schema is valid
Verify no breaking changes to existing workflow compilation
Run make fmt to format code
All tasks completed successfully

Implementation Details

runs-on Field

Added description: "Runner type for workflow execution (GitHub Actions standard field). Typically configured at the job level instead."

This acknowledges the field exists as a standard GitHub Actions property but indicates it's more commonly configured at the job level rather than the top workflow level in agentic workflows.

concurrency Field

Added description: "Concurrency control to limit concurrent workflow runs (GitHub Actions standard field). Agentic workflows use enhanced concurrency management."

This acknowledges the field exists as a standard GitHub Actions property and notes that agentic workflows have their own enhanced concurrency handling, making manual configuration often unnecessary.

Design Philosophy

The descriptions are intentionally minimal and neutral, avoiding promotion of these fields at the top level while documenting their existence. This aligns with the project's design where these fields are better used at the job level or handled automatically by agentic workflow features.

Validation Results

✅ JSON schema validates correctly
✅ Build succeeds with embedded schema
✅ All 60 workflows compile successfully (0 errors, 13 warnings)
✅ Test workflows with both fields work correctly
✅ Python validation confirms descriptions are present
✅ No breaking changes to existing functionality
✅ Code formatted with make fmt

Files Modified

pkg/parser/schemas/main_workflow_schema.json (2 description lines added)
pkg/workflow/schemas/github-workflow.json (formatting applied)

Original prompt

This section details on the original issue you should resolve

<issue_title>[task] Add missing descriptions for runs-on and concurrency in workflow schema</issue_title>
<issue_description>## Objective
Add proper JSON Schema descriptions for the runs-on and concurrency fields in the main workflow schema.

Context

Schema consistency analysis (Discussion #2712) identified that these fundamental GitHub Actions fields are missing descriptions in our workflow schema. While they are standard GHA properties, our schema should describe them for completeness and user clarity.

Current Status: Both fields show "NO DESC" in schema analysis.

Approach

Add a description property to the runs-on field in pkg/parser/schemas/main_workflow_schema.json

Add a description property to the concurrency field in pkg/parser/schemas/main_workflow_schema.json

Ensure descriptions accurately reflect GitHub Actions behavior and how they're used in agentic workflows

Files to Modify

Update: pkg/parser/schemas/main_workflow_schema.json

Suggested Descriptions

runs-on:
"Runner type for workflow execution. Accepts a string (e.g., 'ubuntu-latest'), array of labels, or object with groups/labels for self-hosted runners. Determines the environment where the workflow jobs execute."
concurrency:
"Concurrency control to ensure only a single workflow run or job executes at a time. Accepts a string (concurrency group name) or object with 'group' and 'cancel-in-progress' properties."
Acceptance Criteria

runs-on field has a clear, accurate description

concurrency field has a clear, accurate description

Descriptions follow the same style and format as other schema fields

Schema still validates correctly (run make build and make test-unit)

No breaking changes to existing workflow compilation

Reference

GitHub Actions runs-on docs: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on

GitHub Actions concurrency docs: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency

Priority

Immediate - Part of high-priority schema documentation improvements
Related to #2712

AI generated by Plan Command for discussion #2712</issue_description>

Comments on the Issue (you are @copilot in this section)
@pelikhan This is by design. Add documentation to not report this anymore.

Fixes [task] Add missing descriptions for runs-on and concurrency in workflow schema #2753

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

@pelikhan

- Added description to top-level runs-on field explaining it's a GitHub Actions standard field typically configured at job level - Added description to top-level concurrency field explaining it's a GitHub Actions standard field with enhanced management in agentic workflows - Both descriptions are intentionally minimal per @pelikhan's guidance "by design" - Schema validates correctly and all workflows compile successfully Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2025-10-30T20:17:34Z

@copilot make fmt

github-actions · 2025-10-30T20:18:48Z

Agentic Changeset Generator triggered by this pull request.

Copilot

Pull Request Overview

This PR improves formatting consistency in JSON schema files and updates GitHub Actions dependency references to specific commit hashes.

Reformats multi-value enum and default arrays in workflow schemas to use one value per line for better readability
Adds descriptive documentation for runs-on and concurrency fields in the main workflow schema
Updates actions/setup-node action references across workflow files to newer commit hashes

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
pkg/workflow/schemas/github-workflow.json	Reformatted enum and default arrays for workflow event types to multi-line format
pkg/parser/schemas/main_workflow_schema.json	Added descriptions for `runs-on` and `concurrency` fields
.github/workflows/unbloat-docs.lock.yml	Updated `actions/setup-node` to commit hash `2028fbc5c25fe9cf00d9f06a71cc4710d4507903`
.github/workflows/tidy.lock.yml	Updated `actions/setup-node` to commit hash `a0853c24544627f65ddf259abe73b1d18a591444`
.github/workflows/technical-doc-writer.lock.yml	Updated `actions/setup-node` to commit hash `a0853c24544627f65ddf259abe73b1d18a591444`
.github/workflows/go-logger.lock.yml	Updated `actions/setup-node` to commit hash `a0853c24544627f65ddf259abe73b1d18a591444`

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-30T20:19:32Z

        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
      - name: Setup Node.js
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903


The commit hash 2028fbc5c25fe9cf00d9f06a71cc4710d4507903 is different from the hash used in the other workflow files (a0853c24544627f65ddf259abe73b1d18a591444). Unless there's a specific reason for this difference, all workflows should use the same version for consistency.

Suggested change

uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903

uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-30T20:22:30Z

@copilot make fmt

Done! Formatting applied in commit 7be2481.

Initial plan

39f7b99

Copilot AI assigned Copilot and pelikhan Oct 30, 2025

Copilot started work on behalf of pelikhan October 30, 2025 20:02 View session

Copilot AI and others added 2 commits October 30, 2025 20:08

Initial plan: Add minimal descriptions for runs-on and concurrency

65bc6e8

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add missing descriptions for runs-on and concurrency in workflow schema~~ Add schema descriptions for runs-on and concurrency fields Oct 30, 2025

Copilot AI requested a review from pelikhan October 30, 2025 20:16

Copilot finished work on behalf of pelikhan October 30, 2025 20:16

pelikhan approved these changes Oct 30, 2025

View reviewed changes

Copilot started work on behalf of pelikhan October 30, 2025 20:18 View session

pelikhan marked this pull request as ready for review October 30, 2025 20:18

Copilot AI review requested due to automatic review settings October 30, 2025 20:18

Copilot AI reviewed Oct 30, 2025

View reviewed changes

github-actions Bot and others added 2 commits October 30, 2025 20:21

Add changeset [skip-ci]

1f66d03

Run make fmt to format code

7be2481

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI requested a review from pelikhan October 30, 2025 20:23

Copilot finished work on behalf of pelikhan October 30, 2025 20:23

pelikhan merged commit 3cbdee3 into main Oct 30, 2025
4 checks passed

pelikhan deleted the copilot/add-missing-descriptions-workflow-schema branch October 30, 2025 20:28

lpcox mentioned this pull request May 10, 2026

Bump firewall version to v0.25.43 #31376

Closed

6 tasks

Copilot AI mentioned this pull request May 10, 2026

chore: bump DefaultFirewallVersion to v0.25.43 #31379

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add schema descriptions for runs-on and concurrency fields#2819

Add schema descriptions for runs-on and concurrency fields#2819
pelikhan merged 5 commits into
mainfrom
copilot/add-missing-descriptions-workflow-schema

Copilot AI commented Oct 30, 2025 •

edited

Loading

Uh oh!

pelikhan commented Oct 30, 2025

Uh oh!

github-actions Bot commented Oct 30, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 30, 2025

Uh oh!

Copilot AI commented Oct 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903
	uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444

Conversation

Copilot AI commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add schema descriptions for runs-on and concurrency fields ✅

Summary

Changes Made

Implementation Details

runs-on Field

concurrency Field

Design Philosophy

Validation Results

Files Modified

Context

Approach

Files to Modify

Suggested Descriptions

Acceptance Criteria

Reference

Priority

Comments on the Issue (you are @copilot in this section)

Uh oh!

pelikhan commented Oct 30, 2025

Uh oh!

github-actions Bot commented Oct 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Oct 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Oct 30, 2025 •

edited

Loading